<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="Theme,beekay.colormunch.Theme,commentsLoaded,getAllComments,getCommentByIndex,getCommentCount,getRandomComment,getRandomSwatch,getSwatchByIndex,getSwatchCount,getSwatches,getThemeAuthor,getThemeAuthorId,getThemeCreatedDate,getThemeDownloadCount,getThemeEditedDate,getThemeId,getThemeImage,getThemeLink,getThemeRating,getThemeSprite,getThemeTags,getThemeTitle,loadThemeComments" name="keywords">
<title>beekay.colormunch.Theme</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Theme - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">ColorMunch - an AS3 library for the Adobe Kuler API</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?beekay/colormunch/Theme.html&amp;beekay/colormunch/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Theme</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Theme"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">beekay.colormunch</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Theme</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Theme <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
  Holds Kuler theme data including <code>Swatch</code> objects
  
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#Theme()">Theme</a>(themeId:String, themeTitle:String, themeImage:String, themeLink:String, themeCreatedDate:String, themeEditedDate:String, themeTags:String, themeRating:String, themeDownloadCount:String, themeAuthorId:String, themeAuthor:String, swatchesXML:XMLList, apiKey:String)</div>
<div class="summaryTableDescription">
   Creates a new Theme
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#commentsLoaded()">commentsLoaded</a>():Boolean</div>
<div class="summaryTableDescription">
   Check if the comments for this theme have been loaded
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getAllComments()">getAllComments</a>():Array</div>
<div class="summaryTableDescription">
   Get all the comments for this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCommentByIndex()">getCommentByIndex</a>(index:int):<a href="../colormunch/Comment.html">Comment</a>
</div>
<div class="summaryTableDescription">
   Get a specific comment for this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCommentCount()">getCommentCount</a>():int</div>
<div class="summaryTableDescription">
   Get the total number of comments for this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getRandomComment()">getRandomComment</a>():<a href="../colormunch/Comment.html">Comment</a>
</div>
<div class="summaryTableDescription">
   Get a random comment for this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getRandomSwatch()">getRandomSwatch</a>():<a href="../colormunch/Swatch.html">Swatch</a>
</div>
<div class="summaryTableDescription">
   Get a random swatch from this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSwatchByIndex()">getSwatchByIndex</a>(index:int):<a href="../colormunch/Swatch.html">Swatch</a>
</div>
<div class="summaryTableDescription">
   Get a specific Swatch from this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSwatchCount()">getSwatchCount</a>():int</div>
<div class="summaryTableDescription">
   Get the total number of swatches in this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSwatches()">getSwatches</a>():Array</div>
<div class="summaryTableDescription">
   Get all the swatches in this theme
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeAuthor()">getThemeAuthor</a>():String</div>
<div class="summaryTableDescription">
   Get the theme author's name
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeAuthorId()">getThemeAuthorId</a>():String</div>
<div class="summaryTableDescription">
   Get the theme author's id
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeCreatedDate()">getThemeCreatedDate</a>():Date</div>
<div class="summaryTableDescription">
   Get the theme's created date
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeDownloadCount()">getThemeDownloadCount</a>():int</div>
<div class="summaryTableDescription">
   Get the theme's download count
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeEditedDate()">getThemeEditedDate</a>():Date</div>
<div class="summaryTableDescription">
   Get the theme's last edited date
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeId()">getThemeId</a>():String</div>
<div class="summaryTableDescription">
   Get the theme ID
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeImage()">getThemeImage</a>():String</div>
<div class="summaryTableDescription">
   Get the theme image (png file)
   <p>Note: This is only the url to the theme image</p>
   <p>If you'd prefer to use a vector Sprite see getThemeSprite</p>
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeLink()">getThemeLink</a>():String</div>
<div class="summaryTableDescription">
   Get the link (url) to this theme on the Adobe Kuler website
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeRating()">getThemeRating</a>():String</div>
<div class="summaryTableDescription">
   Get the theme's rating
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeSprite()">getThemeSprite</a>():Sprite</div>
<div class="summaryTableDescription">
   Get a theme Sprite containing child sprites of each swatch
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeTags()">getThemeTags</a>():Array</div>
<div class="summaryTableDescription">
   Get the theme tags
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeTitle()">getThemeTitle</a>():String</div>
<div class="summaryTableDescription">
   Get the theme title
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#loadThemeComments()">loadThemeComments</a>(startIndex:int = 0, itemsPerPage:int = 20):void</div>
<div class="summaryTableDescription">
   Starts the process of loading the comments for this theme
   <p>The following events may dispatched during the process
   <ul><li>ColorMunchEvent.BUSY : This Theme instance is already processing a loadThemeComments request</li>
   <li>ColorMunchEvent.LOAD_ERROR : A problem was encountered loading the feed</li>
   <li>ColorMunchEvent.RESULT_EMPTY : There were zero results returned</li>
   <li>ColorMunchEvent.RESULT_READY : The result has been parsed and the can now to be read (via the explicit getters)</li></ul></p>
   
   </div>
</td><td class="summaryTableOwnerCol">Theme</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="Theme()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">Theme</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function Theme(themeId:String, themeTitle:String, themeImage:String, themeLink:String, themeCreatedDate:String, themeEditedDate:String, themeTags:String, themeRating:String, themeDownloadCount:String, themeAuthorId:String, themeAuthor:String, swatchesXML:XMLList, apiKey:String)</code><p>
   Creates a new Theme
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">themeId</span>:String</code> &mdash;  The theme id
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeTitle</span>:String</code> &mdash;  The theme title
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeImage</span>:String</code> &mdash;  The url of the theme image
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeLink</span>:String</code> &mdash;  The url of the theme on the Adobe Kuler website
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeCreatedDate</span>:String</code> &mdash;  The creation date of the email (yyyy/mm/dd)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeEditedDate</span>:String</code> &mdash;  The last edited date of the theme (yyyy/mm/dd)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeTags</span>:String</code> &mdash;  The theme tags
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeRating</span>:String</code> &mdash;  The theme rating
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeDownloadCount</span>:String</code> &mdash;  The theme download count
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeAuthorId</span>:String</code> &mdash;  The theme author id
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">themeAuthor</span>:String</code> &mdash;  The theme author name
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">swatchesXML</span>:XMLList</code> &mdash;  The swatches XMLList
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">apiKey</span>:String</code> &mdash; Kuler API key
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="commentsLoaded()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">commentsLoaded</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function commentsLoaded():Boolean</code><p>
   Check if the comments for this theme have been loaded
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; <code>true</code> means the comments have already been loaded, <code>false</false> means the comments have not been loaded yet
   
   </td>
</tr>
</table>
</div>
<a name="getAllComments()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getAllComments</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getAllComments():Array</code><p>
   Get all the comments for this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; Comments for this theme. Each array item is of type Comment
   
   </td>
</tr>
</table>
</div>
<a name="getCommentByIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCommentByIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCommentByIndex(index:int):<a href="../colormunch/Comment.html">Comment</a></code><p>
   Get a specific comment for this theme
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The array index of the comment
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Comment.html">Comment</a></code> &mdash; 
                        The requested comment
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getCommentCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCommentCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCommentCount():int</code><p>
   Get the total number of comments for this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; Total comments
   
   </td>
</tr>
</table>
</div>
<a name="getRandomComment()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getRandomComment</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getRandomComment():<a href="../colormunch/Comment.html">Comment</a></code><p>
   Get a random comment for this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Comment.html">Comment</a></code> &mdash; 
                        Random comment
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getRandomSwatch()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getRandomSwatch</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getRandomSwatch():<a href="../colormunch/Swatch.html">Swatch</a></code><p>
   Get a random swatch from this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Swatch.html">Swatch</a></code> &mdash; 
                        A random swatch
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getSwatchByIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSwatchByIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getSwatchByIndex(index:int):<a href="../colormunch/Swatch.html">Swatch</a></code><p>
   Get a specific Swatch from this theme
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The array index of the swatch
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Swatch.html">Swatch</a></code> &mdash; 
                        The specified swatch
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getSwatchCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSwatchCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getSwatchCount():int</code><p>
   Get the total number of swatches in this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; Number of swatches
   
   </td>
</tr>
</table>
</div>
<a name="getSwatches()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSwatches</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getSwatches():Array</code><p>
   Get all the swatches in this theme
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; An array of swatches. Each array item is of type Swatch
   
   </td>
</tr>
</table>
</div>
<a name="getThemeAuthor()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeAuthor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeAuthor():String</code><p>
   Get the theme author's name
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme author name
   
   </td>
</tr>
</table>
</div>
<a name="getThemeAuthorId()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeAuthorId</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeAuthorId():String</code><p>
   Get the theme author's id
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme author ID
   
   </td>
</tr>
</table>
</div>
<a name="getThemeCreatedDate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeCreatedDate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeCreatedDate():Date</code><p>
   Get the theme's created date
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Date</code> &mdash; Theme created date
   
   </td>
</tr>
</table>
</div>
<a name="getThemeDownloadCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeDownloadCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeDownloadCount():int</code><p>
   Get the theme's download count
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; Theme download count
   
   </td>
</tr>
</table>
</div>
<a name="getThemeEditedDate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeEditedDate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeEditedDate():Date</code><p>
   Get the theme's last edited date
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Date</code> &mdash; Theme edited date
   
   </td>
</tr>
</table>
</div>
<a name="getThemeId()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeId</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeId():String</code><p>
   Get the theme ID
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme ID
   
   </td>
</tr>
</table>
</div>
<a name="getThemeImage()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeImage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeImage():String</code><p>
   Get the theme image (png file)
   </p><p>Note: This is only the url to the theme image</p>
   <p>If you'd prefer to use a vector Sprite see getThemeSprite</p>
   
   <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; String
   
   </td>
</tr>
</table>
</div>
<a name="getThemeLink()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeLink</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeLink():String</code><p>
   Get the link (url) to this theme on the Adobe Kuler website
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme link/url
   
   </td>
</tr>
</table>
</div>
<a name="getThemeRating()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeRating</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeRating():String</code><p>
   Get the theme's rating
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme rating
   
   </td>
</tr>
</table>
</div>
<a name="getThemeSprite()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeSprite</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeSprite():Sprite</code><p>
   Get a theme Sprite containing child sprites of each swatch
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Sprite</code> &mdash; Theme swatches sprite
   
   </td>
</tr>
</table>
</div>
<a name="getThemeTags()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeTags</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeTags():Array</code><p>
   Get the theme tags
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; Theme tags. Each array item is of type String
   
   </td>
</tr>
</table>
</div>
<a name="getThemeTitle()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeTitle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeTitle():String</code><p>
   Get the theme title
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; Theme title
   
   </td>
</tr>
</table>
</div>
<a name="loadThemeComments()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">loadThemeComments</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function loadThemeComments(startIndex:int = 0, itemsPerPage:int = 20):void</code><p>
   Starts the process of loading the comments for this theme
   </p><p>The following events may dispatched during the process
   <ul><li>ColorMunchEvent.BUSY : This Theme instance is already processing a loadThemeComments request</li>
   <li>ColorMunchEvent.LOAD_ERROR : A problem was encountered loading the feed</li>
   <li>ColorMunchEvent.RESULT_EMPTY : There were zero results returned</li>
   <li>ColorMunchEvent.RESULT_READY : The result has been parsed and the can now to be read (via the explicit getters)</li></ul></p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> (default = <code>0</code>)<code></code> &mdash; (optional) A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
    </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">itemsPerPage</span>:int</code> (default = <code>20</code>)<code></code> &mdash; (optional) The maximum number of items to display, in the range 1..100. Default is 20.
   
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
